Skip to content

[Custom Transactions] Abstract dust-vs-nondust HTLC sorting away from channel #3921

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tankyleo
Copy link
Contributor

@tankyleo tankyleo commented Jul 10, 2025

Abstract dust-vs-nondust HTLC sorting away from channel

Move these decisions to `TxBuilder` when calculating total dust exposure
and total transaction fees.

We would have liked to delete
`TxBuilder::htlc_success_timeout_dust_limits`, but this is required in
`get_available_balances` to potentially clamp the balance to the dust
limit. Because this method is there, we also use it to determine
whether a single HTLC is dust or nondust (otherwise we would have used a
`TxBuilder::is_dust` call on that HTLC).

Along the way, we also sort non-dust HTLCs in the holding cell using
the exact proposed feerate in `can_send_update_fee`. When checking
whether we can afford the next commitment transaction fee, we should
not count HTLCs in the holding cell using the dust buffer feerate, as
this can trim HTLCs that will be non-dust on the next commitment
transaction. Rather we should use the exact proposed feerate; this
ensures we account for all non-dust HTLCs on the next commitment
transaction.

@ldk-reviews-bot
Copy link

ldk-reviews-bot commented Jul 10, 2025

👋 Thanks for assigning @TheBlueMatt as a reviewer!
I'll wait for their review and will help manage the review process.
Once they submit their review, I'll check if a second reviewer would be helpful.

@tankyleo tankyleo self-assigned this Jul 10, 2025
@tankyleo tankyleo moved this to Goal: Merge in Weekly Goals Jul 10, 2025
@tankyleo
Copy link
Contributor Author

tankyleo commented Jul 10, 2025

We discussed earlier passing the entire list of HTLCs to TxBuilder, and letting it do the dust-vs-non-dust sorting itself. There are nonetheless multiple places in channel that are interested in knowing the exact HTLC dust limit (see get_pending_{inbound, outbound}_htlc_details, get_available_balances_for_scope).

So we prefer to add a single method that surfaces this limit to channel, and then let channel sort HTLCs depending on whether their value sits above or below that amount.

As a result, builders of custom transactions will only have a say on where the dust limit sits, and won't be able to choose arbitrary subsets for dust and non-dust HTLCs.

@carlaKC carlaKC self-requested a review July 10, 2025 17:43
@carlaKC
Copy link
Contributor

carlaKC commented Jul 10, 2025

We discussed earlier passing the entire list of HTLCs to TxBuilder, and letting it do the dust-vs-non-dust sorting itself.

Is the main motivation for this to get all of the commitment-related logic out of channel.rs, or that we think that custom tx builders will want to specifically choose certain htlcs to be dust?

get_available_balances_for_scope

The key questions we're looking to answer seems to be "can I afford a commitment with this theoretical dust/nondust htlc"? This does seem to be something we could move into TxBuilder if we pass the full HTLC set and use a version of HTLCCandidate which just tells TxBuilder whether it is dust (we never actually use this amount other than the dust check).

Sadly here's no getting around needing to know the dust limit if we want to clamp our capacity to that value, so we'd still need to surface htlc_success_timeout_dust_limits.

get_pending_{inbound, outbound}_htlc_details

Tempting to suggest just adding an is_dust check to TxBuilder for these to make it slightly more abstract than surfacing the second stage fees, but given the above requirement to know the exact dust limit maybe we just want to leave as-is.

so tl;dr: I'd be interested in seeing what trying to pull more of the dust logic out into TxBuilder looks like, even if just gives us a clearer idea of where the trait line should be.


Meta note: This has got a lot of overlap with 3bb0586, so I think we should either:

  1. Rebase Update fee and dust handling for zero fee channels #3884 on this PR
  2. Pull the commit out into a common prefactor (I have a slight pref for this, but happy with either)

@tankyleo
Copy link
Contributor Author

Is the main motivation for this to #3775 (comment), or that we think that custom tx builders will want to specifically choose certain htlcs to be dust?

I would say we focus on the latter for this PR, and let the former be the overarching goal :)

so tl;dr: I'd be interested in seeing what trying to pull more of the dust logic out into TxBuilder looks like, even if just gives us a clearer idea of where the trait line should be.

Let me know what you think of this new direction here. Still have some clunkiness to resolve, but that's what it's looking like right now.

@tankyleo
Copy link
Contributor Author

Meta note: This has got a lot of overlap with 3bb0586

Definitely let me rebase on top of your PR, you've rebased once already :)

@tankyleo tankyleo force-pushed the dust-limit branch 2 times, most recently from 12fd6c3 to 067bfa0 Compare July 11, 2025 09:41
@ldk-reviews-bot
Copy link

🔔 1st Reminder

Hey @carlaKC! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

@carlaKC
Copy link
Contributor

carlaKC commented Jul 15, 2025

Let me know what you think of this new direction here.

I like this approach! Definitely prefer being able to move a lot of the dust / second stage tx reasoning into the builder 👍

@ldk-reviews-bot
Copy link

🔔 2nd Reminder

Hey @carlaKC! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

@tankyleo tankyleo removed the request for review from carlaKC July 18, 2025 18:01
Move these decisions to `TxBuilder` when calculating total dust exposure
and total transaction fees.

We would have liked to delete
`TxBuilder::htlc_success_timeout_dust_limits`, but this is required in
`get_available_balances` to potentially clamp the balance to the dust
limit. Because this method is there, we also use it to determine
whether a single HTLC is dust or nondust (otherwise we would have used a
`TxBuilder::is_dust` call on that HTLC).

Along the way, we also sort non-dust HTLCs in the holding cell using
the exact proposed feerate in `can_send_update_fee`. When checking
whether we can afford the next commitment transaction fee, we should
not count HTLCs in the holding cell using the dust buffer feerate, as
this can trim HTLCs that will be non-dust on the next commitment
transaction. Rather we should use the exact proposed feerate; this
ensures we account for all non-dust HTLCs on the next commitment
transaction.
@tankyleo tankyleo changed the title [Custom Transactions] Abstract the weight of HTLC transactions away from channel [Custom Transactions] Abstract dust-vs-nondust HTLC sorting away from channel Jul 21, 2025
@tankyleo tankyleo marked this pull request as ready for review July 21, 2025 08:56
@tankyleo tankyleo requested a review from TheBlueMatt July 21, 2025 08:56
@tankyleo
Copy link
Contributor Author

I'm aware I still owe a follow-up PR from the previous PR in this project, will push that soon in a separate PR :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Goal: Merge
Development

Successfully merging this pull request may close these issues.

3 participants